Skip to content

Update RMM docs to use NVIDIA theme#2443

Merged
rapids-bot[bot] merged 7 commits into
rapidsai:mainfrom
bdice:nvidia-docs-theme
Jun 26, 2026
Merged

Update RMM docs to use NVIDIA theme#2443
rapids-bot[bot] merged 7 commits into
rapidsai:mainfrom
bdice:nvidia-docs-theme

Conversation

@bdice

@bdice bdice commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

Description

Updates the RMM docs to use the NVIDIA Sphinx theme, removes the local RAPIDS custom CSS/JS includes that are injected by docs post-processing, disables Doxygen dot graph generation to avoid the Graphviz/GTK/Wayland dependency chain, and adds context to the C++ memory resources landing page.

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@bdice bdice requested a review from a team as a code owner June 9, 2026 20:54
@bdice bdice requested a review from msarahan June 9, 2026 20:54
@coderabbitai

coderabbitai Bot commented Jun 9, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 07078f8a-c754-4d7c-9063-4ea92cef6416

📥 Commits

Reviewing files that changed from the base of the PR and between 9963ba6 and a1712f3.

📒 Files selected for processing (3)
  • conda/environments/all_cuda-133_arch-aarch64.yaml
  • conda/environments/all_cuda-133_arch-x86_64.yaml
  • dependencies.yaml
✅ Files skipped from review due to trivial changes (1)
  • conda/environments/all_cuda-133_arch-x86_64.yaml
🚧 Files skipped from review as they are similar to previous changes (1)
  • dependencies.yaml

📝 Walkthrough

Summary by CodeRabbit

  • Documentation

    • Updated the docs styling and theme across the project.
    • Removed external custom CSS/JavaScript includes from the documentation build.
    • Added clearer introductory guidance for memory resource documentation.
  • Chores

    • Adjusted documentation environment settings to use the new theme package and drop unused documentation dependencies.

Walkthrough

The PR updates documentation configuration to use nvidia_sphinx_theme, removes graphviz and pydata-sphinx-theme from docs dependency manifests, disables Doxygen dot generation, removes custom header assets, and adds introductory memory-resources documentation.

Changes

Documentation Theme and Infrastructure Migration

Layer / File(s) Summary
Sphinx Configuration Migration
docs/conf.py
The Sphinx config changes the copyright year, project name, HTML theme, and setup hook registrations.
Python Environment and Dependency Updates
dependencies.yaml, conda/environments/all_cuda-129_arch-*.yaml, conda/environments/all_cuda-133_arch-*.yaml
The shared docs dependency set and CUDA environment manifests remove graphviz and pydata-sphinx-theme, and add nvidia-sphinx-theme under pip.
C++ Documentation Infrastructure Adjustments
cpp/doxygen/Doxyfile, cpp/doxygen/header.html
Doxygen disables dot-based diagram generation, and the header template stops loading the RAPIDS custom JavaScript and stylesheet.
Memory Resources Documentation
docs/cpp/memory_resources/index.md
The memory resources page adds introductory text describing memory resources and resource adaptors.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested labels

improvement

Suggested reviewers

  • msarahan
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately reflects the main documentation theme update in the changeset.
Description check ✅ Passed The description is clearly related to the PR and summarizes the docs theme, Doxygen, and landing page changes.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
dependencies.yaml (1)

349-350: ⚡ Quick win

Consider pinning nvidia-sphinx-theme version.

Installing nvidia-sphinx-theme without a version constraint could lead to unexpected breaking changes if the theme is updated. Consider adding a version range for stability.

📌 Suggested version constraint
           - pip:
-              - nvidia-sphinx-theme
+              - nvidia-sphinx-theme>=1.0,<2.0
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@dependencies.yaml` around lines 349 - 350, The pip dependency entry for
nvidia-sphinx-theme is unpinned; update the dependencies.yaml pip list entry for
nvidia-sphinx-theme to include an explicit version constraint (either a fixed
version like ==X.Y.Z or a safe range like >=X.Y,<X+1.0 or ~=X.Y) to prevent
accidental breaking changes; locate the nvidia-sphinx-theme item in the pip list
and replace the bare name with the chosen versioned specifier and run dependency
resolution to verify compatibility.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@dependencies.yaml`:
- Around line 349-350: The pip dependency entry for nvidia-sphinx-theme is
unpinned; update the dependencies.yaml pip list entry for nvidia-sphinx-theme to
include an explicit version constraint (either a fixed version like ==X.Y.Z or a
safe range like >=X.Y,<X+1.0 or ~=X.Y) to prevent accidental breaking changes;
locate the nvidia-sphinx-theme item in the pip list and replace the bare name
with the chosen versioned specifier and run dependency resolution to verify
compatibility.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 5e3a806b-1bb6-4190-8c0a-d864b8d0ad5e

📥 Commits

Reviewing files that changed from the base of the PR and between a66679d and 45856ef.

📒 Files selected for processing (9)
  • conda/environments/all_cuda-129_arch-aarch64.yaml
  • conda/environments/all_cuda-129_arch-x86_64.yaml
  • conda/environments/all_cuda-132_arch-aarch64.yaml
  • conda/environments/all_cuda-132_arch-x86_64.yaml
  • cpp/doxygen/Doxyfile
  • cpp/doxygen/header.html
  • dependencies.yaml
  • docs/conf.py
  • docs/cpp/memory_resources/index.md
💤 Files with no reviewable changes (1)
  • cpp/doxygen/header.html

@bdice bdice self-assigned this Jun 9, 2026
@bdice bdice added doc Documentation non-breaking Non-breaking change labels Jun 9, 2026
@bdice bdice moved this to In Progress in RMM Project Board Jun 9, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sphinx changes LGTM. Can't comment on the rest.

Comment thread docs/cpp/memory_resources/index.md Outdated
bdice added 2 commits June 26, 2026 13:35
Removed instructions to browse memory resource implementations.
@bdice

bdice commented Jun 26, 2026

Copy link
Copy Markdown
Collaborator Author

/merge

@rapids-bot rapids-bot Bot merged commit a3aad10 into rapidsai:main Jun 26, 2026
85 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in RMM Project Board Jun 26, 2026
rapids-bot Bot pushed a commit to rapidsai/cudf that referenced this pull request Jul 1, 2026
Updates the cuDF docs to use the NVIDIA Sphinx theme, following the same direction as rapidsai/rmm#2443.

This removes the local RAPIDS custom CSS/JS injection from the Sphinx and Doxygen docs configuration, switches the cuDF and dask-cuDF Sphinx configs to `nvidia_sphinx_theme`, and updates docs dependencies from `pydata-sphinx-theme` to `nvidia-sphinx-theme`.

## Validation

- Parsed edited Sphinx config files with `ast.parse`.
- Parsed `dependencies.yaml` and generated conda environment YAML files with `yaml.safe_load`.
- Ran commit-time pre-commit hooks, including `RAPIDS dependency file generator`.

Authors:
  - Bradley Dice (https://github.com/bdice)

Approvers:
  - Vyas Ramasubramani (https://github.com/vyasr)

URL: #23035
bdice added a commit that referenced this pull request Jul 7, 2026
## Description

- uses `NVIDIA RMM` for the documentation project and landing-page
branding
- removes the inactive Twitter/X icon
- uses `NVIDIA RMM Documentation` consistently for HTML, LaTeX, man, and
Texinfo output
- retains the GitHub icon and NVIDIA theme defaults

Follow-up to rapidsai/build-planning#300 and #2443.

## Validation

- Doxygen generation passes
- strict Sphinx HTML build passes with `-n -W --keep-going`
- targeted pre-commit hooks pass

## Checklist

- [x] I am familiar with the [Contributing
Guidelines](https://github.com/rapidsai/rmm/blob/HEAD/CONTRIBUTING.md).
- [x] New or existing tests cover these changes.
- [x] The documentation is up to date with these changes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation non-breaking Non-breaking change

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants